Inscoper::DeviceConfig¶

DeviceConfig class provides information for device configuration. More...

#include <DeviceConfig.h>

Public Functions¶

	Name
	DeviceConfig(Inscoper::EDriverType driverType) Constructor.
void	fromXML(Inscoper::XMLNode & deviceNode) Load from XML.
void	toXML(Inscoper::XMLNode & xmlParent) Save to XML.
const std::string &	getId() const Get the ID of the device.
void	setId(const std::string & id) Set the ID of the device.
Inscoper::EDriverType	getDriverType() const Get the driver type of the device.
void	setDriverType(Inscoper::EDriverType driverType) Set the driver type of the device.
const std::vector< Inscoper::SubDeviceConfigPtr > &	getSubDeviceConfigList() const Get the sub-device configuration list.
void	setSubDeviceConfigList(const std::vector< Inscoper::SubDeviceConfigPtr > & subDevices) Set the sub-device configuration list.
void	addSubDeviceConfig(const Inscoper::SubDeviceConfigPtr & subDevice) Add a sub-device configuration to the list.
const Inscoper::DriverConfigPtr &	getDriverConfig() const Get the driver configuration.
void	setDriverConfig(const Inscoper::DriverConfigPtr & driverConfig) Set the driver configuration.

Detailed Description¶

class Inscoper::DeviceConfig;

DeviceConfig class provides information for device configuration.

This class holds the configuration parameters for a specific device, including its ID, driver type, sub-devices, and driver-specific settings.

Public Functions Documentation¶

function DeviceConfig¶

explicit DeviceConfig(
    Inscoper::EDriverType driverType
)

Constructor.

Parameters:

driverType : The driver type of the device

Initializes a new instance of DeviceConfig with the specified driver type.

function fromXML¶

void fromXML(
    Inscoper::XMLNode & deviceNode
)

Load from XML.

Parameters:

deviceNode : The XML node containing device information

Exceptions:

InscoperException If an error occurs

Populates the device configuration from the provided XML node.

function toXML¶

void toXML(
    Inscoper::XMLNode & xmlParent
)

Save to XML.

Parameters:

xmlParent : The parent XML node

Exceptions:

InscoperException If an error occurs

Serializes the device configuration to the specified parent XML node.

function getId¶

const std::string & getId() const

Get the ID of the device.

Return: The ID of the device

Retrieves the unique identifier of the device.

function setId¶

void setId(
    const std::string & id
)

Set the ID of the device.

Parameters:

id : The ID of the device

Assigns a unique identifier to the device.

function getDriverType¶

Inscoper::EDriverType getDriverType() const

Get the driver type of the device.

Return: The driver type of the device

Retrieves the type of driver associated with this device.

function setDriverType¶

void setDriverType(
    Inscoper::EDriverType driverType
)

Set the driver type of the device.

Parameters:

driverType : The driver type of the device

Sets the type of driver for this device.

function getSubDeviceConfigList¶

const std::vector< Inscoper::SubDeviceConfigPtr > & getSubDeviceConfigList() const

Get the sub-device configuration list.

Return: The list of sub-device configurations

Retrieves the list of sub-device configurations associated with this device.

function setSubDeviceConfigList¶

void setSubDeviceConfigList(
    const std::vector< Inscoper::SubDeviceConfigPtr > & subDevices
)

Set the sub-device configuration list.

Parameters:

subDevices : The list of sub-device configurations

Replaces the current list of sub-device configurations.

function addSubDeviceConfig¶

void addSubDeviceConfig(
    const Inscoper::SubDeviceConfigPtr & subDevice
)

Add a sub-device configuration to the list.

Parameters:

subDevice : The sub-device configuration to add

Appends a new sub-device configuration to the device.

function getDriverConfig¶

const Inscoper::DriverConfigPtr & getDriverConfig() const

Get the driver configuration.

Return: The driver configuration

Retrieves the specific configuration for the underlying driver.

function setDriverConfig¶

void setDriverConfig(
    const Inscoper::DriverConfigPtr & driverConfig
)

Set the driver configuration.

Parameters:

driverConfig : The driver configuration

Assigns the specific configuration for the underlying driver.

Updated on 2026-04-02 at 10:55:35 +0200